@types/passport

What is @types/passport?

The @types/passport npm package provides TypeScript type definitions for Passport.js, a popular authentication middleware for Node.js. These type definitions allow TypeScript developers to use Passport.js in their applications with the benefits of type safety and IntelliSense in their code editors.

What are @types/passport's main functionalities?

Authentication Middleware Initialization

This code initializes Passport as middleware in an Express application, enabling authentication functionalities.

import * as passport from 'passport';
app.use(passport.initialize());

Serialize User

This function defines how to store the user in the session storage, typically saving the user ID.

passport.serializeUser((user, done) => {
  done(null, user.id);
});

Deserialize User

This function defines how to retrieve the user from the session storage, using the user ID to fetch the user record from the database.

passport.deserializeUser((id, done) => {
  User.findById(id, (err, user) => {
    done(err, user);
  });
});

Use of Strategy

This code sample demonstrates how to implement a local authentication strategy using Passport.js. It involves checking the username and password against stored records.

import { Strategy as LocalStrategy } from 'passport-local';
passport.use(new LocalStrategy(
  function(username, password, done) {
    User.findOne({ username: username }, function (err, user) {
      if (err) { return done(err); }
      if (!user) { return done(null, false); }
      if (!user.verifyPassword(password)) { return done(null, false); }
      return done(null, user);
    });
  }
));

Other packages similar to @types/passport

@types/express-session

Provides TypeScript definitions for Express session middleware, similar to how @types/passport provides definitions for Passport.js. While @types/express-session focuses on session handling, @types/passport focuses on user authentication.

@types/jsonwebtoken

Offers TypeScript definitions for the jsonwebtoken package, which is used for generating JWTs for authentication purposes. It complements @types/passport by providing types for handling JWTs, whereas @types/passport is more broadly focused on authentication strategies.

README

Installation

npm install --save @types/passport

Summary

This package contains type definitions for passport (http://passportjs.org).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/passport.

Additional Details

• Last updated: Mon, 28 Oct 2024 20:34:09 GMT
• Dependencies: @types/express

Credits

These definitions were written by Horiuchi_H, Eric Naeseth, Igor Belagorudsky, Tomek Łaziuk, Daniel Perez Alvarez, Kevin Stiehl, and Oleg Vaskevich.